home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_1
/
dug104.zip
/
DUG.DOC
< prev
next >
Wrap
Text File
|
1993-01-13
|
11KB
|
293 lines
Garth Bigelow
TopherSoft Engineering
DUG
Door Usage Graph
01/12/93
DUG is an extremely easy to use yet fairly flexable Door Usage Graph
generator. DUG will create color bulletins using any color code format.
DUG - Door Usage Graph Generator
TopherSoft Engineering
RR620 State Road
Vineyard Haven, MA 02568
TopherSoft BBS: 508-693-7396 Speed 1200,2400,19200
***********************************************************************
DUG copyright (c) 1993 by TopherSoft Engineering & Garth Bigelow.
DUG is distributed as Shareware. You are free to inspect DUG on a trail
basis for 30 days. If after thirty days you wish to continue using DUG
you must Register the program (See the end of this documentation for
details) otherwise you must remove DUG from your system.
I have included NO crippling code in DUG. Also no delays or "pester"
screens have been included. What you see is what you get.
Responce to this approach will determine whether future TopherSoft
products contain features available only thru Registration or whether
we produce more products like DUG that are fully functional from the
start.
***********************************************************************
1. Installation
The Installation of DUG has been designed to be as simple as possible
for a utility of it's type.
Installation consists of three steps.
Step 1: Copy DUG.EXE & DUG.CF into a sub-directory that is in the path.
Example: Copy DUG.* \BBS
[Optionally an Enviromental Variable DUG can be set up to
point to DUG.EXE.
Example: SET DUG=\BBS\
]
Step 2: Edit DUG.CF
DUG.CF contains eleven commented lines, looking something
like this:
--------------------------------------------------
D:\BBS\INCLUDES\DOORUSE.ANS
20 Maximum Number of Doors to Display (Example: Top 20)
A Ranking Method (A = By Accesses, M = by Minutes Used)
- Color Code Terminator
$ Escape Character Code
$[0;36m- Color Code For Titles
$[1;31m- Color Code For Door Names
$[1;34m- Color Code For Access Bar
$[0;31m- Color Code For Last Access
$[0;32m- Color Code For Uage Time Average Bar
$[0;37m- Color Code To Return to Normal
--------------------------------------------------
Unless you wish to use a color code scheme other than
ANSI.SYS escape codes (such as Searchlight Color Codes)
the first line of DUG.CF is probably the only one that
needs to be changed.
Line 1: This must be the name and path of the Door Usage
Graph being created.
Line 2: Describes how many Doors to List on Graph.
The Top 20, The Top 5, etc.
Line 3: Is the Ranking Method.
"M" rankings the graph by the Number of Minutes Bar.
Any other key ranks by Number of Accesses.
Line 4: Is the Character that will be used to end signify
the end of a color color.
Any character that is not used in your color codes
may be used.
Line 5: ESC characters are difficult to type in most edits
but are part of a many color code schemes. This line
specifies a character that will be translated into
an ESC in the color code lines below.
Line 6: This is the Color Code Sequence for the Titles.
Line 7: This is the Color Code Sequence for the Door Names.
Line 8: This is the Color Code Sequence for the Number of
Accesses Bar on the Graph.
Line 9: This is the Color Code Sequence for the Last Access
Info.
Line 10: This is the Color Code Sequence for the Minutes of
Usage Bar on the Graph.
Line 11: This is the Color Code Sequence that is displayed at
the end to return the color to normal.
Step 3: Hook DUG into the BBS's Doors.
This is the hardest part, merely because you have to do
this step for every Door that you want to be included in
the Usage Graph.
This Step requires adding two line to each BAT file that
runs each door. [Note: If you are running the door directly
you will have to set up a BAT file to run it before proceeding
with this step.]
The Lines to add are:
DUG "door name" IN
DUG "door name" OUT
These lines are included so that they stradle the program
being run.
Let's say one of your doors is Ultimate Universe and your
BAT file to run it looks like this:
-----------------------------------------------------------
@ECHO OFF
CD\BBS\DOORS\UU
ULTIMATE -%1 -P%2 -T%3 /P%4 /B%5
Copy RANK.U? \BBS\INCLUDES >nul
COPY NEWPAPER.U?U \BBS\INCLUDES >nul
CD\BBS
-----------------------------------------------------------
The BAT file should be modified to look like this:
-----------------------------------------------------------
@ECHO OFF
CD\BBS\DOORS\UU
DUG "Ultimate Universe" IN
ULTIMATE -%1 -P%2 -T%3 /P%4 /B%5
DUG "Ultimate Universe" OUT
Copy RANK.U? \BBS\INCLUDES >nul
COPY NEWPAPER.U?U \BBS\INCLUDES >nul
CD\BBS
-----------------------------------------------------------
It is very important that the door name be the same in both
lines, including Upper and Lower case.
And, yes the quotes are needed.
[Note: If you just wish to track the usage and not the time
the second (OUT) line may be omitted.]
-----------------------------------------------------------------------
That's it! Your Door Usage Graph is now ready to be displayed.
Additional Commands
There are two addition commands for maintaining the graph. These
commands are SET and RESET.
RESET: RESET is used to remove a door from an existing graph file.
The syntax is:
DUG "door name" RESET
If you remove a door from your BBS, this command will let
you remove it from the graph.
SET: SET is for use well switching over from another Door Graph
program. This allows you to preset the information for the
graph.
The syntax is:
DUG "door name" SET accesses [minutes]
This sets the number of times accessed and minutes used
values for door name.
If minutes is omitted it will be set to zero.
If accesses is omitted SET is ignored.
An additional option also exists for OUT and RESET:
NOGRAPH: The NOGRAPH option looks like this:
DUG "door name" OUT NOGRAPH
This option forces DUG to terminate before it creates the
Door Usage Graph. Thus if you only want the graph updated
at certain times (like daily) this option allows that.
This option is mostly for use on XTs where the time taken
to create the graph file name be noticeable.
Note: You can force a graph by resetting a non-existant
graph entry, like se:
DUG "fake door name" RESET
IN will accept the NOGRAPH parameter but as IN does not
create a graph it is redundant.
The Legalities
1 Sharing DUG Files
You are welcome to share unmodified copies of DUG.ZIP with your friends
and associates for their evaluation. This documentation and the config-
uration file (DUG.CF) must be provided with all copies of DUG except
by prior written permission from TopherSoft Engineering.
Unmodified copies of TopherSoft Engineering shareware and demo files
including DUG.ZIP may be distributed by "shareware distributors"
provided:
1) the files are clearly identified as shareware,
2) the cost of the distribution is nominal.
Otherise, no version of DUG may be sold without the prior written
permission of TopherSoft Engineering.
Distribution of DUG in any medium without this documentation file is an
unauthorized modification to DUG that deprives the rightful author of
registration revenues. That is a theft of intellectual property. Such
distribution damages the author by forcing the user and author to waste
time and phone bills scrounging for the documentation, and answering
questions that are fully covered in the documentation.
Thank you for your support.
The Registration
After a short evaluation period, of not more than 30 days, ethical users
must register their copy of DUG with a check for $15.00 or more) in U.S.
funds.
DO NOT send the funds to me, please make the check or money order out to:
Hubbard Diantics Foundation
and send to:
Hubbard Diantics Foundation
3009 N. Lincoln
Chicago, IL 60657
RE: Freeloader Fund
ATTN: Gary Kveton
In a very real sense I would not have the creative ability to be a
shareware software author without their help and patience a few years
ago. It's time to give something back.
The funds are sufficient, I see no reason to make you fill out forms.
But please remember that Registration is the only encouragement a
Shareware author gets. If you use the program beyond the trail period
then the program has value to you and thus the author should be
reimbursed for that value.
Piracy is stealing.
Only you make shareware work.